Skip to content

Conversation

@lucassus
Copy link
Contributor

@lucassus lucassus commented Jul 17, 2025

This pull request updates the documentation for the Maxio Advanced Billing SDK, including enhancements to readability, version upgrades, and new additions to the SDK's utility classes. It also introduces structural improvements to the documentation hierarchy and corrects some formatting inconsistencies.

Documentation Updates and Improvements:

  • Updated README.md to improve readability, simplify steps for making API calls, and add links to relevant sections.
  • Upgraded SDK version references from 6.1.0 to 7.0.0 across all documentation, including dependency installation, API client initialization, and controller links. [1] [2]

New Additions:

  • Added a new ApiHelper utility class documentation, detailing methods for JSON serialization and deserialization.

Structural and Formatting Improvements:

  • Standardized relative links to documentation files for better navigation (e.g., updated links in doc/api-exception.md and doc/client.md). [1] [2]
  • Introduced a new "SDK Infrastructure" section in README.md to organize configuration, HTTP, and utility class documentation.

Minor Corrections:

  • Fixed formatting inconsistencies in parameter descriptions (e.g., added extra line breaks for clarity in doc/controllers/api-exports.md).
  • Renamed "ApiException Class" to "ApiException" for consistency.

@lucassus lucassus self-assigned this Jul 17, 2025
@lucassus lucassus changed the title Release 7.0.0 [FND-3] Release 7.0.0 Jul 24, 2025
@lucassus lucassus marked this pull request as ready for review July 24, 2025 09:33
@lucassus lucassus merged commit 7e177fb into main Jul 24, 2025
3 of 4 checks passed
@lucassus lucassus deleted the publish branch July 24, 2025 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants